<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="discoveryengine_v1.html">Discovery Engine API</a> . <a href="discoveryengine_v1.projects.html">projects</a> . <a href="discoveryengine_v1.projects.locations.html">locations</a> . <a href="discoveryengine_v1.projects.locations.collections.html">collections</a> . <a href="discoveryengine_v1.projects.locations.collections.engines.html">engines</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="discoveryengine_v1.projects.locations.collections.engines.assistants.html">assistants()</a></code>
</p>
<p class="firstline">Returns the assistants Resource.</p>

<p class="toc_element">
  <code><a href="discoveryengine_v1.projects.locations.collections.engines.completionConfig.html">completionConfig()</a></code>
</p>
<p class="firstline">Returns the completionConfig Resource.</p>

<p class="toc_element">
  <code><a href="discoveryengine_v1.projects.locations.collections.engines.controls.html">controls()</a></code>
</p>
<p class="firstline">Returns the controls Resource.</p>

<p class="toc_element">
  <code><a href="discoveryengine_v1.projects.locations.collections.engines.conversations.html">conversations()</a></code>
</p>
<p class="firstline">Returns the conversations Resource.</p>

<p class="toc_element">
  <code><a href="discoveryengine_v1.projects.locations.collections.engines.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>

<p class="toc_element">
  <code><a href="discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html">servingConfigs()</a></code>
</p>
<p class="firstline">Returns the servingConfigs Resource.</p>

<p class="toc_element">
  <code><a href="discoveryengine_v1.projects.locations.collections.engines.sessions.html">sessions()</a></code>
</p>
<p class="firstline">Returns the sessions Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, engineId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Engine.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a Engine.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Engine.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the Engines associated with the project.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an Engine</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, engineId=None, x__xgafv=None)</code>
  <pre>Creates a Engine.

Args:
  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Metadata that describes the training and serving parameters of an Engine.
  &quot;appType&quot;: &quot;A String&quot;, # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
  &quot;chatEngineConfig&quot;: { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    &quot;agentCreationConfig&quot;: { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
      &quot;business&quot;: &quot;A String&quot;, # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
      &quot;defaultLanguageCode&quot;: &quot;A String&quot;, # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
      &quot;location&quot;: &quot;A String&quot;, # Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
      &quot;timeZone&quot;: &quot;A String&quot;, # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
    },
    &quot;allowCrossRegion&quot;: True or False, # Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
    &quot;dialogflowAgentToLink&quot;: &quot;A String&quot;, # The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
  },
  &quot;chatEngineMetadata&quot;: { # Additional information of a Chat Engine. Fields in this message are output only. # Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    &quot;dialogflowAgent&quot;: &quot;A String&quot;, # The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
  },
  &quot;commonConfig&quot;: { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
    &quot;companyName&quot;: &quot;A String&quot;, # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
  },
  &quot;configurableBillingApproach&quot;: &quot;A String&quot;, # Optional. Configuration for configurable billing approach.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp the Recommendation Engine was created at.
  &quot;dataStoreIds&quot;: [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
    &quot;A String&quot;,
  ],
  &quot;disableAnalytics&quot;: True or False, # Optional. Whether to disable analytics for searches performed on this engine.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
  &quot;features&quot;: { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it&#x27;s present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;industryVertical&quot;: &quot;A String&quot;, # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
  &quot;mediaRecommendationEngineConfig&quot;: { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    &quot;engineFeaturesConfig&quot;: { # More feature configs of the selected engine type. # Optional. Additional engine features config.
      &quot;mostPopularConfig&quot;: { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
        &quot;timeWindowDays&quot;: &quot;A String&quot;, # The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.
      },
      &quot;recommendedForYouConfig&quot;: { # Additional feature configurations for creating a `recommended-for-you` engine. # Recommended for you engine feature config.
        &quot;contextEventType&quot;: &quot;A String&quot;, # The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.
      },
    },
    &quot;optimizationObjective&quot;: &quot;A String&quot;, # The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =&gt; `ctr` `others-you-may-like` =&gt; `ctr`
    &quot;optimizationObjectiveConfig&quot;: { # Custom threshold for `cvr` optimization_objective. # Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
      &quot;targetField&quot;: &quot;A String&quot;, # Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.
      &quot;targetFieldValueFloat&quot;: 3.14, # Required. The threshold to be applied to the target (e.g., 0.5).
    },
    &quot;trainingState&quot;: &quot;A String&quot;, # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.
    &quot;type&quot;: &quot;A String&quot;, # Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
  &quot;searchEngineConfig&quot;: { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    &quot;searchAddOns&quot;: [ # The add-on that this search engine enables.
      &quot;A String&quot;,
    ],
    &quot;searchTier&quot;: &quot;A String&quot;, # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
  },
  &quot;solutionType&quot;: &quot;A String&quot;, # Required. The solutions of the engine.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp the Recommendation Engine was last updated.
}

  engineId: string, Required. The ID to use for the Engine, which will become the final component of the Engine&#x27;s resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a Engine.

Args:
  name: string, Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a Engine.

Args:
  name: string, Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata that describes the training and serving parameters of an Engine.
  &quot;appType&quot;: &quot;A String&quot;, # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
  &quot;chatEngineConfig&quot;: { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    &quot;agentCreationConfig&quot;: { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
      &quot;business&quot;: &quot;A String&quot;, # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
      &quot;defaultLanguageCode&quot;: &quot;A String&quot;, # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
      &quot;location&quot;: &quot;A String&quot;, # Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
      &quot;timeZone&quot;: &quot;A String&quot;, # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
    },
    &quot;allowCrossRegion&quot;: True or False, # Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
    &quot;dialogflowAgentToLink&quot;: &quot;A String&quot;, # The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
  },
  &quot;chatEngineMetadata&quot;: { # Additional information of a Chat Engine. Fields in this message are output only. # Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    &quot;dialogflowAgent&quot;: &quot;A String&quot;, # The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
  },
  &quot;commonConfig&quot;: { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
    &quot;companyName&quot;: &quot;A String&quot;, # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
  },
  &quot;configurableBillingApproach&quot;: &quot;A String&quot;, # Optional. Configuration for configurable billing approach.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp the Recommendation Engine was created at.
  &quot;dataStoreIds&quot;: [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
    &quot;A String&quot;,
  ],
  &quot;disableAnalytics&quot;: True or False, # Optional. Whether to disable analytics for searches performed on this engine.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
  &quot;features&quot;: { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it&#x27;s present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;industryVertical&quot;: &quot;A String&quot;, # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
  &quot;mediaRecommendationEngineConfig&quot;: { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    &quot;engineFeaturesConfig&quot;: { # More feature configs of the selected engine type. # Optional. Additional engine features config.
      &quot;mostPopularConfig&quot;: { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
        &quot;timeWindowDays&quot;: &quot;A String&quot;, # The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.
      },
      &quot;recommendedForYouConfig&quot;: { # Additional feature configurations for creating a `recommended-for-you` engine. # Recommended for you engine feature config.
        &quot;contextEventType&quot;: &quot;A String&quot;, # The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.
      },
    },
    &quot;optimizationObjective&quot;: &quot;A String&quot;, # The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =&gt; `ctr` `others-you-may-like` =&gt; `ctr`
    &quot;optimizationObjectiveConfig&quot;: { # Custom threshold for `cvr` optimization_objective. # Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
      &quot;targetField&quot;: &quot;A String&quot;, # Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.
      &quot;targetFieldValueFloat&quot;: 3.14, # Required. The threshold to be applied to the target (e.g., 0.5).
    },
    &quot;trainingState&quot;: &quot;A String&quot;, # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.
    &quot;type&quot;: &quot;A String&quot;, # Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
  &quot;searchEngineConfig&quot;: { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    &quot;searchAddOns&quot;: [ # The add-on that this search engine enables.
      &quot;A String&quot;,
    ],
    &quot;searchTier&quot;: &quot;A String&quot;, # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
  },
  &quot;solutionType&quot;: &quot;A String&quot;, # Required. The solutions of the engine.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp the Recommendation Engine was last updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists all the Engines associated with the project.

Args:
  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. (required)
  filter: string, Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH
  pageSize: integer, Optional. Not supported.
  pageToken: string, Optional. Not supported.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for EngineService.ListEngines method.
  &quot;engines&quot;: [ # All the customer&#x27;s Engines.
    { # Metadata that describes the training and serving parameters of an Engine.
      &quot;appType&quot;: &quot;A String&quot;, # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
      &quot;chatEngineConfig&quot;: { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
        &quot;agentCreationConfig&quot;: { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
          &quot;business&quot;: &quot;A String&quot;, # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
          &quot;defaultLanguageCode&quot;: &quot;A String&quot;, # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
          &quot;location&quot;: &quot;A String&quot;, # Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
          &quot;timeZone&quot;: &quot;A String&quot;, # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
        },
        &quot;allowCrossRegion&quot;: True or False, # Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
        &quot;dialogflowAgentToLink&quot;: &quot;A String&quot;, # The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
      },
      &quot;chatEngineMetadata&quot;: { # Additional information of a Chat Engine. Fields in this message are output only. # Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
        &quot;dialogflowAgent&quot;: &quot;A String&quot;, # The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
      },
      &quot;commonConfig&quot;: { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
        &quot;companyName&quot;: &quot;A String&quot;, # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
      },
      &quot;configurableBillingApproach&quot;: &quot;A String&quot;, # Optional. Configuration for configurable billing approach.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp the Recommendation Engine was created at.
      &quot;dataStoreIds&quot;: [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
        &quot;A String&quot;,
      ],
      &quot;disableAnalytics&quot;: True or False, # Optional. Whether to disable analytics for searches performed on this engine.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
      &quot;features&quot;: { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it&#x27;s present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;industryVertical&quot;: &quot;A String&quot;, # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
      &quot;mediaRecommendationEngineConfig&quot;: { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
        &quot;engineFeaturesConfig&quot;: { # More feature configs of the selected engine type. # Optional. Additional engine features config.
          &quot;mostPopularConfig&quot;: { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
            &quot;timeWindowDays&quot;: &quot;A String&quot;, # The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.
          },
          &quot;recommendedForYouConfig&quot;: { # Additional feature configurations for creating a `recommended-for-you` engine. # Recommended for you engine feature config.
            &quot;contextEventType&quot;: &quot;A String&quot;, # The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.
          },
        },
        &quot;optimizationObjective&quot;: &quot;A String&quot;, # The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =&gt; `ctr` `others-you-may-like` =&gt; `ctr`
        &quot;optimizationObjectiveConfig&quot;: { # Custom threshold for `cvr` optimization_objective. # Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
          &quot;targetField&quot;: &quot;A String&quot;, # Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.
          &quot;targetFieldValueFloat&quot;: 3.14, # Required. The threshold to be applied to the target (e.g., 0.5).
        },
        &quot;trainingState&quot;: &quot;A String&quot;, # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.
        &quot;type&quot;: &quot;A String&quot;, # Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
      },
      &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
      &quot;searchEngineConfig&quot;: { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
        &quot;searchAddOns&quot;: [ # The add-on that this search engine enables.
          &quot;A String&quot;,
        ],
        &quot;searchTier&quot;: &quot;A String&quot;, # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
      },
      &quot;solutionType&quot;: &quot;A String&quot;, # Required. The solutions of the engine.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp the Recommendation Engine was last updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Not supported.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates an Engine

Args:
  name: string, Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. (required)
  body: object, The request body.
    The object takes the form of:

{ # Metadata that describes the training and serving parameters of an Engine.
  &quot;appType&quot;: &quot;A String&quot;, # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
  &quot;chatEngineConfig&quot;: { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    &quot;agentCreationConfig&quot;: { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
      &quot;business&quot;: &quot;A String&quot;, # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
      &quot;defaultLanguageCode&quot;: &quot;A String&quot;, # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
      &quot;location&quot;: &quot;A String&quot;, # Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
      &quot;timeZone&quot;: &quot;A String&quot;, # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
    },
    &quot;allowCrossRegion&quot;: True or False, # Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
    &quot;dialogflowAgentToLink&quot;: &quot;A String&quot;, # The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
  },
  &quot;chatEngineMetadata&quot;: { # Additional information of a Chat Engine. Fields in this message are output only. # Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    &quot;dialogflowAgent&quot;: &quot;A String&quot;, # The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
  },
  &quot;commonConfig&quot;: { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
    &quot;companyName&quot;: &quot;A String&quot;, # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
  },
  &quot;configurableBillingApproach&quot;: &quot;A String&quot;, # Optional. Configuration for configurable billing approach.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp the Recommendation Engine was created at.
  &quot;dataStoreIds&quot;: [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
    &quot;A String&quot;,
  ],
  &quot;disableAnalytics&quot;: True or False, # Optional. Whether to disable analytics for searches performed on this engine.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
  &quot;features&quot;: { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it&#x27;s present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;industryVertical&quot;: &quot;A String&quot;, # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
  &quot;mediaRecommendationEngineConfig&quot;: { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    &quot;engineFeaturesConfig&quot;: { # More feature configs of the selected engine type. # Optional. Additional engine features config.
      &quot;mostPopularConfig&quot;: { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
        &quot;timeWindowDays&quot;: &quot;A String&quot;, # The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.
      },
      &quot;recommendedForYouConfig&quot;: { # Additional feature configurations for creating a `recommended-for-you` engine. # Recommended for you engine feature config.
        &quot;contextEventType&quot;: &quot;A String&quot;, # The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.
      },
    },
    &quot;optimizationObjective&quot;: &quot;A String&quot;, # The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =&gt; `ctr` `others-you-may-like` =&gt; `ctr`
    &quot;optimizationObjectiveConfig&quot;: { # Custom threshold for `cvr` optimization_objective. # Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
      &quot;targetField&quot;: &quot;A String&quot;, # Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.
      &quot;targetFieldValueFloat&quot;: 3.14, # Required. The threshold to be applied to the target (e.g., 0.5).
    },
    &quot;trainingState&quot;: &quot;A String&quot;, # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.
    &quot;type&quot;: &quot;A String&quot;, # Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
  &quot;searchEngineConfig&quot;: { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    &quot;searchAddOns&quot;: [ # The add-on that this search engine enables.
      &quot;A String&quot;,
    ],
    &quot;searchTier&quot;: &quot;A String&quot;, # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
  },
  &quot;solutionType&quot;: &quot;A String&quot;, # Required. The solutions of the engine.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp the Recommendation Engine was last updated.
}

  updateMask: string, Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata that describes the training and serving parameters of an Engine.
  &quot;appType&quot;: &quot;A String&quot;, # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
  &quot;chatEngineConfig&quot;: { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    &quot;agentCreationConfig&quot;: { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
      &quot;business&quot;: &quot;A String&quot;, # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
      &quot;defaultLanguageCode&quot;: &quot;A String&quot;, # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
      &quot;location&quot;: &quot;A String&quot;, # Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.
      &quot;timeZone&quot;: &quot;A String&quot;, # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
    },
    &quot;allowCrossRegion&quot;: True or False, # Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
    &quot;dialogflowAgentToLink&quot;: &quot;A String&quot;, # The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
  },
  &quot;chatEngineMetadata&quot;: { # Additional information of a Chat Engine. Fields in this message are output only. # Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    &quot;dialogflowAgent&quot;: &quot;A String&quot;, # The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
  },
  &quot;commonConfig&quot;: { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
    &quot;companyName&quot;: &quot;A String&quot;, # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
  },
  &quot;configurableBillingApproach&quot;: &quot;A String&quot;, # Optional. Configuration for configurable billing approach.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp the Recommendation Engine was created at.
  &quot;dataStoreIds&quot;: [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
    &quot;A String&quot;,
  ],
  &quot;disableAnalytics&quot;: True or False, # Optional. Whether to disable analytics for searches performed on this engine.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
  &quot;features&quot;: { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it&#x27;s present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;industryVertical&quot;: &quot;A String&quot;, # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
  &quot;mediaRecommendationEngineConfig&quot;: { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    &quot;engineFeaturesConfig&quot;: { # More feature configs of the selected engine type. # Optional. Additional engine features config.
      &quot;mostPopularConfig&quot;: { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
        &quot;timeWindowDays&quot;: &quot;A String&quot;, # The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.
      },
      &quot;recommendedForYouConfig&quot;: { # Additional feature configurations for creating a `recommended-for-you` engine. # Recommended for you engine feature config.
        &quot;contextEventType&quot;: &quot;A String&quot;, # The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.
      },
    },
    &quot;optimizationObjective&quot;: &quot;A String&quot;, # The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =&gt; `ctr` `others-you-may-like` =&gt; `ctr`
    &quot;optimizationObjectiveConfig&quot;: { # Custom threshold for `cvr` optimization_objective. # Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
      &quot;targetField&quot;: &quot;A String&quot;, # Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.
      &quot;targetFieldValueFloat&quot;: 3.14, # Required. The threshold to be applied to the target (e.g., 0.5).
    },
    &quot;trainingState&quot;: &quot;A String&quot;, # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.
    &quot;type&quot;: &quot;A String&quot;, # Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
  &quot;searchEngineConfig&quot;: { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    &quot;searchAddOns&quot;: [ # The add-on that this search engine enables.
      &quot;A String&quot;,
    ],
    &quot;searchTier&quot;: &quot;A String&quot;, # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
  },
  &quot;solutionType&quot;: &quot;A String&quot;, # Required. The solutions of the engine.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp the Recommendation Engine was last updated.
}</pre>
</div>

</body></html>